home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / gemxx19.zoo / gem++19 / man / grect.man < prev    next >
Text File  |  1993-05-04  |  2KB  |  67 lines
  1.                      GEM++ - C++ LIBRARIES FOR GEM/AES/VDI
  2.  
  3.  
  4.  
  5. NAME
  6.      GRect - AES rectangle class
  7.  
  8. DESCRIPTION
  9.      The AES often deal with rectangular areas, especially in relation
  10.      to windows and objects.
  11.  
  12.      This class derives from the AES "GRECT" object, and is therefore
  13.      usable in the various AES functions that require GRECTs.
  14.  
  15. CONSTRUCTORS
  16.      GRect()
  17.        Create a GRect with undefined dimensions.
  18.  
  19.      GRect(int x, int y, int width, int height)
  20.        Create a GRect with the given (x,y) position and size.
  21.  
  22. METHODS
  23.      GRect& MoveAbs(int x, int y)
  24.        Move the GRect to the given position.  Returns self after move.
  25.      GRect& MoveRel(int xOffset, int yOffset)
  26.        Move the GRect by the given amounts.  Returns self after move.
  27.      GRect& Resize(int w, int h)
  28.        Resize the GRect to the given dimensions.  Returns self after resize.
  29.      GRect& SetRect(int x, int y, int width, int height)
  30.        Set the position and size of the GRect.
  31.      
  32.      void GetOrigin(int& x, int& y)
  33.        Returns the (x,y) position of the GRect.
  34.  
  35.      void GetSize(int& width, int& height)
  36.        Returns the size of the GRect.
  37.  
  38.      void GetRect(int& x, int& y, int& width, int& height)
  39.        Returns the (x,y) position and size of the GRect.
  40.      
  41.      GRect& Clip(const GRect& border)
  42.        Clip the rectangle to the given border.
  43.  
  44.      GRect& Constrain(const GRect& border)
  45.        Move the rectangle such that it is within the given rectangle.
  46.        The size is unchanged, so the rectangle may not fix, it which
  47.        case, it is centred.
  48.      
  49.      int operator==(const GRect&)
  50.      int operator!=(const GRect&)
  51.        Compare rectangles.
  52.  
  53. BUGS
  54.      Bugs in GEM++ should be reported to warwick@cs.uq.oz.au
  55.  
  56. AUTHOR
  57.      Andre Pareis, 1992
  58.      pareis@cs.tu-berlin.de
  59.  
  60. COPYING
  61.      GEM++ is free and protected under the GNU Library General Public
  62.      License.
  63.  
  64.      You are free to copy and modify these sources, provided you
  65.      acknowledge the origin by retaining this notice, and adhere to
  66.      the conditions described in the GNU LGPL.
  67.